<?php
/**
 * Copyright 2011 MaGdev
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *    * Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *    * The names of the authors may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @package      Mashape API-Documentor
 * @author       Marco Graetsch <info@magdev.de>
 * @copyright    2011 Marco Graetsch.development
 * @license      http://opensource.org/licenses/bsd-license.php New BSD License
 * @link         https://code.google.com/p/apidocumentor/
 */

/**
 * Mashape API-Dcoumentor abstract renderer
 *
 * @author magdev
 */
abstract class Mashdoc_Renderer_Abstract implements Mashdoc_Renderer_Interface, SplObserver
{
	/** @var array */
	protected $_options = array();
	
	/** @var boolean */
	protected $_isRendered = false;
	
	/** @var array */
	protected $_params = array();
	
	/** @var DOMDocument */
	protected $_xml = null;
	
	/** @var Mashdoc_Helper_DataUri */
	protected $_uriHelper = null;
	
	/** @var string */
	protected $_html = null;
	
	
	/**
	 * Constructor
	 *
	 * @param DOMDocument|null $xml
	 * @return void
	 */
	public function __construct(DOMDocument $xml = null)
	{
		if (!is_null($xml)) {
			$this->setXml($xml);
		}
	}
	
	
	/**
	 * Set the XML document
	 *
	 * @param DOMDocument $xml
	 * @return Mashdoc_Renderer_Abstract
	 */
	public function setXml(DOMDocument $xml)
	{
		$this->_xml = $xml;
		return $this;
	}
	
	
	/**
	 * Update this object
	 *
	 * @see SplObserver::update()
	 * @return void
	 */
	public function update(SplSubject $subject)
	{
		$this->_options = $subject->getOptions();
		$this->setXml($subject->getApiDocument());
	}
	
	
	/**
	 * Output the generated code
	 * .
	 * @param boolean $sendHeader
	 * @return void
	 */
	public function output($sendHeader = true)
	{
		if ($sendHeader) {
			header('Content-Type: '.$this->_options['mimetype'].';charset='.$this->_options['encoding']);
		}
		echo $this->__toString();
	}
	
	
	/**
	 * The parameters for the output
	 *
	 * @param array|Mashdoc_Metadata_Interface $params
	 * @return Mashdoc_Renderer_Abstract
	 */
	public function setParams($params)
	{
	    if ($params instanceof Mashdoc_Metadata_Interface) {
	        $params = $params->getTags();
	    }
		foreach ($params as $k => $v) {
			$this->setParam($k, $v);
		}
		return $this;
	}
	
	
	/**
	 * The a single parameter
	 *
	 * @param string $key
	 * @param mixed $value
	 * @return Mashdoc_Renderer_Abstract
	 */
	public function setParam($key, $value = null)
	{
		if (is_null($value) && isset($this->_params[$key])) {
			unset($this->_params[$key]);
			return;
		}
		$this->_params[(string) $key] = $value;
		return $this;
	}
	
	
	/**
	 * Get all parameters
	 *
	 * @return array
	 */
	public function getParams()
	{
		return $this->_params;
	}
	
	
	/**
	 * Get a single parameter
	 *
	 * @param string $key
	 * @param mixed $default
	 * @return mixed
	 */
	public function getParam($key, $default = '')
	{
		if (isset($this->_params[$key])) {
			return $this->_params[$key];
		}
		return $default;
	}
	
	
	/**
	 * Check if the output is already rendered
	 *
	 * @return boolean
	 */
	public function isRendered()
	{
		return $this->_isRendered;
	}
	
	
	/**
	 * Compute parameters
	 *
	 * @return array
	 */
	protected function _getParameters()
	{
		$params = $this->_params;
		if (isset($params['apiUrl']) && !isset($params['component'])) {
		    $params['component'] = substr($params['apiUrl'], strrpos($params['apiUrl'], '/')+1);
		}
		$uri = new Mashdoc_Helper_DataUri($this->_options);
		$params = array_merge($params, $uri->toArray());
		return $params;
	}
}
?>